Skip to main content

Send-MQTTMessage

SYNOPSIS​

SYNTAX​

Send-MQTTMessage [-Session] <MqttClient> [-Topic] <String> [[-Payload] <String>] [-Quiet] [[-QosLevel] <Int32>]
 [-Retain] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

This function will publish a message to a MQTT topic.

EXAMPLES​

EXAMPLE 1​

Send-MQTTMEssage -Session $Session -Topic 'foo' -Payload '{"attribute":"value"}'

PARAMETERS​

-Session​

Defines the MQTTBroker session to use

Type: MqttClient
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Topic​

Defines the topic to publish the message to

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Payload​

Defines the message as a string

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Quiet​

Defines that messages are sent without outputing any objects.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-QosLevel​

Defines the Quality of Service level for the message.

Type: Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False

-Retain​

Defines if the message should be retained by the MQTTBroker.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction​

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters​

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS​

OUTPUTS​

NOTES​

EDIT THIS DOC​

This page was auto-generated from the powershell command comment based help. To edit the content of this page, update the script file comment based help on github Github